<html xmlns="http://www.w3.org/1999/xhtml"><head><title>Zend Framework Extras API Documentation</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/jquery-ui.css" type="text/css"></link><link rel="stylesheet" href="css/docblox/jquery-ui-1.8.16.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
            $(document).ready(function() {
                $(".filetree").treeview({
                    collapsed: true,
                    persist: "cookie"
                });

                $("#accordion").accordion({
                    collapsible: true,
                    autoHeight:  false,
                    fillSpace:   true
                });

                $(".tabs").tabs();
            });
        </script></head><body><div xmlns="" class="content">
<div class="sub-page-main-header-api-documentation"><h2>API Documentation</h2></div>
<div class="dotted-line"></div>
</div>
<div xmlns="" id="content">
<script xmlns:dbx="http://docblox-project.org/xsl/functions">

      function filterElements()
      {
        inherited = !$('#show-inherited').hasClass('deselected');
        public    = !$('#show-public').hasClass('deselected');
        protected = !$('#show-protected').hasClass('deselected');
        private   = !$('#show-private').hasClass('deselected');

        $('div.public').each(function(index, val) {
            $(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.protected').each(function(index, val) {
            $(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
        });
        $('div.private').each(function(index, val) {
            $(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
        });
      }

      $(document).ready(function() {
        $('a.gripper').click(function() {
            $(this).nextAll('div.code-tabs').slideToggle();
            $(this).children('img').toggle();
            return false;
        });

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');

        $('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
            $(this).parent().nextAll('div.code-tabs').slideToggle();
            $(this).parent().prevAll('a.gripper').children('img').toggle();
            return false;
        });

        $('div.code-tabs').hide();
        $('a.gripper').show();
        $('div.code-tabs:empty').prevAll('a.gripper').html('');

        $('#show-public, #show-protected, #show-private, #show-inherited')
            .css('cursor', 'pointer')
            .click(function(){
                $(this).toggleClass('deselected');
                if ($(this).hasClass('deselected')) {
                  $(this).fadeTo('fast', '0.4');
                } else {
                  $(this).fadeTo('fast', '1.0');
                }
                filterElements();
                return false;
            });
        $('#show-protected, #show-private').click();

        // add the sliding behaviour to the file navigation and show it
        // it is initially hidden for non-JS users.
        $("#file-nav-box").show().hover(function() {
            $("#file-nav-container").slideDown(400);
        }, function() {
            $("#file-nav-container").slideUp(400);
        });
      });

      
    </script><h1 xmlns:dbx="http://docblox-project.org/xsl/functions" class="file">ZendX/JQuery/View/Helper/AjaxLink.php</h1>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" id="file-nav-box">
<div id="file-nav-options">
              Show:
              <img src="images/icons/visibility_public.png" id="show-public"><img src="images/icons/visibility_protected.png" id="show-protected"><img src="images/icons/visibility_private.png" id="show-private"><span class="attribute" id="show-inherited">inherited</span>
</div>
<div id="file-nav-container">
<ul id="file-nav"><li>
<a href="#classes"><img src="images/icons/class.png" height="14">
                          Classes
                      </a><ul><li><a href="#%5CZendX_JQuery_View_Helper_AjaxLink">\ZendX_JQuery_View_Helper_AjaxLink</a></li></ul>
</li></ul>
<div style="clear: left;"></div>
</div>
<div id="file-nav-tab">
              Table of Contents
          </div>
</div>
<a xmlns:dbx="http://docblox-project.org/xsl/functions" name="top" class="anchor"></a><div id="file-description">
<p xmlns:dbx="http://docblox-project.org/xsl/functions" class="short-description">Zend Framework</p>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="long-description"><p>LICENSE</p>

<p>This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.</p>
</div>
</div>
<dl class="file-info">
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Category</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">License</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Package</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">ZendX_JQuery
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Subpackage</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">View
         
    </dd>
<dt xmlns:dbx="http://docblox-project.org/xsl/functions">Version</dt>
<dd xmlns:dbx="http://docblox-project.org/xsl/functions">$Id: AjaxLink.php 24400 2011-08-26 08:55:28Z padraic $
         
    </dd>
</dl>
<a name="classes" class="anchor"></a><a xmlns:dbx="http://docblox-project.org/xsl/functions" id="\ZendX_JQuery_View_Helper_AjaxLink" class="anchor"></a><h2 xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">\ZendX_JQuery_View_Helper_AjaxLink<div class="to-top"><a href="#top">jump to top</a></div>
</h2>
<div xmlns:dbx="http://docblox-project.org/xsl/functions" class="class">
<small class="package"><b>Package: </b>ZendX\JQuery\View</small><p class="short-description">jQuery Accordion Pane, goes with Accordion Container</p>
<div class="long-description">
</div>
<dl class="class-info">
<dt>Parent(s)</dt>
<dd>\Zend_View_Helper_HtmlElement</dd>
<dt>Copyright</dt>
<dd>Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
         
    </dd>
<dt>License</dt>
<dd>
<a href="http://framework.zend.com/license/new-bsd">New BSD License</a>
         
    </dd>
<dt>Uses</dt>
<dd>\Zend_Json
         
    </dd>
</dl>
<h3>Properties</h3>
<div>
<a id="\ZendX_JQuery_View_Helper_AjaxLink::$currentLinkCallbackId" class="anchor"></a><div class="property private">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/property.png" alt="Property"><img src="images/icons/visibility_private.png" style="margin-right: 5px" alt="private">
                 <span class="highlight">$currentLinkCallbackId</span>= '1'
                </code><div class="description">
<span class="attribute">static</span><p class="short-description">Static because multiple instances accross views of AjaxLink could reset the counter and a
subcontainer because of this single private class variable seems too much overhead.</p>
</div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Default value</strong><code>1</code><strong>Details</strong><dl class="property-info">
<dt>Type</dt>
<dd></dd>
<dt>Staticvar</dt>
<dd>Integer
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
<h3>Methods</h3>
<div>
<a id="\ZendX_JQuery_View_Helper_AjaxLink::_determineRequestHandler()" class="anchor"></a><div class="method protected">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_protected.png" style="margin-right: 5px" alt="protected"><span class="highlight">_determineRequestHandler</span><span class="nb-faded-text">(
          Array $options, Boolean $hasParams
          )
        </span>
        :
          String</code><div class="description"><p class="short_description">Determine which request method (GET or POST) should be used.</p></div>
<div class="code-tabs">
<div class="long-description"><p>Normally the request method is determined implicitly by the rule,
if addiotional params are sent, POST, if not GET. You can overwrite
this behaviiour by implicitly setting $options['method'] = "POST|GET";</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$options</th>
<td>Array</td>
<td><em></em></td>
</tr>
<tr>
<th>$hasParams</th>
<td>Boolean</td>
<td><em></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>String</td>
<td></td>
</tr>
</table>
</div>
<div class="clear"></div>
</div>
<a id="\ZendX_JQuery_View_Helper_AjaxLink::ajaxLink()" class="anchor"></a><div class="method public">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/method.png" alt="method"><img src="images/icons/visibility_public.png" style="margin-right: 5px" alt="public"><span class="highlight">ajaxLink</span><span class="nb-faded-text">(
          String $label, String $url, Array $options
              =
              null, Array $params
              =
              null
          )
        </span>
        :
          String</code><div class="description"><p class="short_description">Create an anchor that enables ajax-based requests and handling of the response.</p></div>
<div class="code-tabs">
<div class="long-description"><p>This helper creates links that make XmlHttpRequests to the server. It allows to
inject the response into the DOM. Fancy effects going with the links can be enabled
via simple callback shortnames. The functionality is mostly controlled by the $options
array:</p>

<p>$options
 Key                Behaviour
 =================================================================================
 'update'        Update a container with the content fetched from $url
 'method'        Explicit Requesting method mimicing the jQuery functionality: GET, POST
 'inline'        True or false, wheater to inline the javascript in onClick=""
                    atttribute or append it to jQuery onLoad Stack.
 'complete'      String specifies javascript called after successful request or a
                    shortname of a jQuery effect that should be applied to the 'update' element.
 'beforeSend'   String specifies javascript called before the request is sent, or a
                    shortname of a jQuery effect that should be applied to the link clicked.
 'noscript'     True/false, include a noscript variant that directly requests
                    the given $url (make sure to check $request->isXmlHttpRequest())
 'dataType'     What type of data is the response returning? text, html, json?
 'title'            HTML Attribute title of the Anchor
 'class'            HTML Attribute class of the Anchor
 'id'           HTML Attribute id of the Anchor
 'attribs'      Array of Key-Value pairs with HTML Attribute names and their content.</p>

<p>BeforeSend Callback:
Can include shortcuts as a string assignment to fire of effects before sending of request.
Possible shortcuts are 'fadeOut', 'fadeOutSlow', 'hide', 'hideSlow', 'slideUp', 'flash',</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$label</th>
<td>String</td>
<td><em><p>Urls Title</p></em></td>
</tr>
<tr>
<th>$url</th>
<td>String</td>
<td><em><p>Link to Point to</p></em></td>
</tr>
<tr>
<th>$options</th>
<td>Array</td>
<td><em></em></td>
</tr>
<tr>
<th>$params</th>
<td>Array</td>
<td><em><p>Key Value Pairs of GET/POST Parameters</p>
</em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>String</td>
<td></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Example</dt>
<dd>$options = array('beforeSend' => 'hideSlow', 'complete' => 'show');
         
    </dd>
<dt>Link</dt>
<dd>
<a href="http://docs.jquery.com/Ajax">http://docs.jquery.com/Ajax</a>
         
    </dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.15.1</a>.
    </small></body></html>
